feat: vertical nav for quickstart and identity #2020
Conversation
christiannwamba
requested review from
vinckr,
aeneasr,
zepatrik and
piotrmsc
as code owners
christiannwamba
changed the title
There was a problem hiding this comment.
great start :)
i left some comments on what I think could be improved.
one side note for later: if we have the SDK guides as the first starting point in the docs I think we need to make sure that they work very well!
also would be good to have the OAuth2 and Permissions quickstarts under Start as well, but I assume have that planned for a later step.
I hope I caught all the changes but this looks very clean to navigate already!
src/sidebar.ts
Outdated
| "getting-started/local-development", | ||
| { | ||
| type: "category", | ||
| label: "Authenctication", |
There was a problem hiding this comment.
| label: "Authenctication", | |
| label: "Authentication", |
src/sidebar.ts
Outdated
| }, | ||
| { | ||
| type: "category", | ||
| label: "Credentials", |
There was a problem hiding this comment.
wouldn't the other auth methods like password, passkeys etc. also fall under credentials?
not sure what I would except in this category
There was a problem hiding this comment.
Thant's a good catch. Thanks
src/sidebar.ts
Outdated
| "kratos/passwordless/passkeys", | ||
| "kratos/passwordless/one-time-code", | ||
| "kratos/organizations/organizations", | ||
| "kratos/emails-sms/custom-email-templates", |
There was a problem hiding this comment.
the custom email templates doc is different than the others in this category - maybe it makes sense for emails/communication to have their own category? or move it to the "configuration" category?
There was a problem hiding this comment.
I think the title is what is misleading. The content shares how to setup for account recovery via email, login code, registration code, etc. The title should be something like: "Email notification" and then it would live under Authentication
Thanks @vinckr. Create a few issues to track your suggestions: |
There was a problem hiding this comment.
Couple of smaller points from my end but we are getting there! :)
-
Can we add back button from "Start/Identity/Fedration/Permissions" pages from horizontal nav to redirect back to docs landing page like we have with Reference?
-
Fedration -> Guides -> OpenID Connect SSO : this section is also applicable to identity (kratos).
Scenario : when Hydra talks to kratos to authenticate the user but kratos can federate to yet another IDP. -
If you go to : Identities -> Guides -> Ory Actions then you have "Identity management" and "Oauth2 webhooks" which point to hydra and you have exactly same oauth hooks linked if you start from federation -> guides.
-
Please think of "Reference" section on the horizontal nav bar, should we keep it or not? currently it's a mixture of topics either for Ory Network like Rate limits, custom domains etc or for Open Source related topics or both at the same time :D
Thanks @piotrmsc Fixed 1,2, and 3. Created an issue: #2036 for 4 and researching a solution now |
Related Issue or Design Document
Checklist
If this pull request addresses a security vulnerability,
I confirm that I got approval (please contact [email protected]) from the maintainers to push the changes.
Further comments